home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / rnet200f.zip / RNET_REF.DOC < prev    next >
Text File  |  1993-06-02  |  19KB  |  388 lines
  1.    ╓──────┐ ╓────┐╓─┐ ╓─────┐ ╓─────┐
  2.    ║ ╒══╗ │ ║ ╒╗ │║ │ ║ ╒═══╛ ╚═╗ ╒═╛    Version: 2.00
  3.    ║ └──╜ │ ║ │║ │║ │ ║ └─┐     ║ │      Release: < beta >
  4.    ║ ╒═╗ ╒╛ ║ │║ │║ │ ║ ╒═╛     ║ │
  5.    ║ │ ║ └┐ ║ │║ └╜ │ ║ └───┐   ║ │      Copyright 1989-93 Robert Vostreys
  6.    ╚═╛ ╚══╛ ╚═╛╚════╛ ╚═════╛   ╚═╛      All Rights Reserved Worldwide
  7. _______________________________________________________________________________
  8.                  Quick Reference Guide to RNET Configuration
  9.                   (See RNET.DOC for a complete description)
  10.  
  11. Commandline Syntax:
  12.   RNET EXPORT host.cfg [options]   {Export messages for HOST_ID}
  13.   RNET IMPORT host.cfg [options]   {Import messages from HOST_ID}
  14.   RNET PACK   host.cfg [options]   {Build auto-pack batch only}
  15.   RNET SET    host.cfg cnf# msg#   {cnf#=conference number or ALL}
  16.                                    {msg#=message number, -number, or TOP}
  17. Commandline Options:
  18.   -b = bios screen writes     -q = quiet (no chirp on warning)
  19.   -m = monochrome colors      -d = disable CRC32 dup checking if enabled
  20.   -c = reduce cga snow        -z = disable DOS flush during imports
  21.  
  22.   ONLY ## = process *only* specified conference (for import/export)
  23.  
  24. Environment:
  25.   RNET=      d:\dir\      (for the location of the CFG files and logs)
  26.   TEMP=      d:\dir\      (where RNET should place working/scratch files)
  27.   PCBDAT=    d:\dir\name  (of your PCBOARD.DAT file (should already be set))
  28. _______________________________________________________________________________
  29.  
  30.                               CFG File Keywords
  31.                       (new keywords for 2.xx have a '|')
  32.  
  33. Host and Local Identification:
  34.  
  35. |  HOSTID       = 1-8 character 'name' of your host system (used for .QWK, etc)
  36. |  LOCALID      = 1-8 character 'name' of your system (used for .QWK, routing)
  37.    HOSTSYSOP    = Your host sysop's name
  38.    LOCALSYSOP   = Your name
  39.    MAKESYSOP    = YES|NO (make LOCALSYSOP name into "SYSOP" when importing?)
  40.    KEYCODE      = single character (used for cross and gateway echo confs)
  41.  
  42. Packet Locations and Processing:
  43.  
  44.    COMPRESS     = Command to compress outgoing REP packets  ('PKZIP.EXE -ex')
  45.    UNCOMPRESS   = Command to uncompress incoming QWK        ('PKUNZIP.EXE -o')
  46.    WORKDIR      = d:\dir\  (where RNET should unzip packets; overrides environ)
  47.    QWKPATH      = d:\dir\  (where QWK packets should be found)
  48.    REPPATH      = d:\dir\  (where REP packets should be built)
  49. |  KEEPPATH     = d:\dir\  (location for backup QWK, REP, and RPF files)
  50. |  KEEPQWKS     = 0-9      (number of backup QWK packets to keep)
  51. |  KEEPREPS     = 0-9      (number of backup REP packets to keep)
  52. |  KEEPRPFS     = 0-9      (number of backup RPF (RNET pointer) files to keep)
  53.    REVERSEQWK   = YES|NO   (reverse order of QWK import for Robocomm folks)
  54.    KILLQWK      = YES|NO   (delete QWK packets after SUCCESSFUL importing)
  55.  
  56. Conferences:
  57.  
  58.    CONF         = Local#,Host# [:Tag# FilterFile ConfFlags...]
  59. |  GLOBALFILTER = d:\dir\name  (filename of global 'filter' instructions)
  60. |  DEFAULTFLAGS = PUBLIC PRIVATE TOALL ADDRESSED ANSI FILES IGNOREECHO ...
  61. |  AGELIMIT     = 0-9999       (oldest message to accept (default=30 days))
  62. |  RPF          = d:\dir\name  (filename of RNET pointer file ('hostid.RPF'))
  63.  
  64. Old-style Conference Flags:
  65.  
  66.    PRIVATE      = YES|NO         (global "send private mail in all confs")
  67.    PRIVATECONF  = Conf#,Conf#... (list of conferences to accept private msgs)
  68.    COMMENTS     = Conf#,Conf#... (list of conferences to accept comment msgs)
  69.    IGNOREECHO   = Conf#,Conf#... (list of conferences to ignore echo flag)
  70.    ANSI         = Conf#,Conf#... (list of conferences to accept ANSI)
  71.  
  72. Old-style Conference Filters:
  73.  
  74.    HANDLE       = NAME,NAME   (translate names; see RNET.DOC)
  75.    TCAN         = NAME        (do not accept messages to/from this person)
  76.    TOCAN        = NAME        (do not accept messages addressed TO this person)
  77.    FRCAN        = NAME        (do not accept messages FROM this person)
  78.    PRIVATEUSER  = NAME        (user allowed to send private msg in public echo)
  79.    TCANTAG      = search txt  (do not accept msgs with 'search txt' in tagline)
  80.    KILLTAG      = search txt  (strip/remove taglines with 'search txt')
  81.  
  82. Taglines:
  83.  
  84.    RTAG         = ON|OFF|FIDO|INTERNET  (style of " ■ RNET v.vv:" part)
  85.    HOSTORIGIN   = tagline to append to host generated messages (same as HTAG0=)
  86.    ORIGIN       = tagline to append to locally generated messages (same LTAG0=)
  87.    HTAG0..9     = up to 10 different taglines for host generated messages
  88.    LTAG0..9     = up to 10 different taglines for locally generated messages
  89.  
  90. Auto Message Packing Batch (see RNETPACK.DOC):
  91.  
  92. |  AUTOPACK     = YES|NO      (automatically build RNETPACK.BAT after import)
  93. |  PACKLIST     = d:\dir\name (filename of auto-pack rules ('RNETPACK.LST'))
  94. |  PACKBAT      = d:\dir\name (filename of auto-pack batch ('RNETPACK.BAT'))
  95.  
  96. Reports (see @..@ codes listing below):
  97.  
  98.    LONGCALLER   = YES|NO      (write long or short report to callers log)
  99.    CALLERSLOG   = d:\dir\name (overrides PCBoard callers log file)
  100. |  RNETLOG      = d:\dir\name (filename for history log ('RNET.LOG'))
  101. |  EVENTLOG     = d:\dir\name (filename of "last mail event at" ('EVENT.LOG'))
  102.    CONFREPORT   = d:\dir\name (filename of usage analysis ('hostid.LOG'))
  103.    DAILY        = d:\dir\name (filename of daily report ('VERBOSE.day'))
  104.    SUPERLOG     = d:\dir\name (filename for log of *every* message header)
  105. |  TAGLOG       = d:\dir\name (filename for listing all net taglines)
  106. |  ORIGINLOG    = d:\dir\name (filename for listing all @ORIGIN lines seen)
  107. |  NOTICELOG    = d:\dir\name (filename for notice warnings ('NOTICE.LOG'))
  108. |  WARNINGLOG   = d:\dir\name (filename for serious warnings ('WARNING.LOG'))
  109. |  ERRORLOG     = d:\dir\name (filename for critical errors ('ERROR.LOG'))
  110.  
  111. Other:
  112.  
  113.    KILLRE       = YES|NO  (remove "RE:" and "(R)" from subject line)
  114.    NODE         = node#   (override PCBoard.dat node number)
  115. |  YOUHAVEMAIL  = YES|NO  (update "you have mail waiting" flags)
  116. |  ROUTED       = YES|NO  (enable or disable @ORIGIN and @SEENBY lines)
  117. |  SWAPPATH     = d:\dir\ (dir for swapping to disk (or use current dir))
  118. |  REFER        = YES|NO  (keep 'refer numbers' in sync from system to system)
  119. |  CHECK_NUMBERS= YES|NO  (if REFER=YES; dup check new msg#s vs previous msgs)
  120. |  CHECK_CRC    = YES|NO  (if REFER=YES; dup check new msg#s using X.25 CRC32)
  121. _______________________________________________________________________________
  122.  
  123. -------------------------------------------------------------------------------
  124.   Below are some quickie docs on the new features of RNET.  These features and
  125.   functions will be fully documented in the release RNET.DOC. This information
  126.   is included for those who can figure out what I'm talking about (heh).
  127. -------------------------------------------------------------------------------
  128.  
  129.                       Flags for DEFAULTFLAGS= and CONF=
  130.  
  131. Flags to ENABLE:
  132.  
  133.    PUB     PUBLIC                     (allow public messages)
  134.    PVT     PRIVATE                    (allow private messages)
  135.    COM     COMMENTS                   (allow comments)
  136.    ADD     ADDRESSED    TOANYONE      (allow messages addressed to someone)
  137.    ALL     TOALL                      (allow messages addressed to 'ALL')
  138.    ANS     ANSI                       (allow and fix ANSI sequences)
  139.    ATC     ATCODES                    (allow PCBoard @..@ codes)
  140.    FIL     FILES        ATTACH        (allow file attaches)
  141.    NOE     IGNOREECHO   ALLECHO       (echo messages regardless of ECHO flag)
  142.    ROU     ROUTED                     (allow routed messages)
  143.  
  144. Flags to DISABLE:
  145.  
  146.    NOPUB   NOPUBLIC     NO_PUBLIC     (do not allow public messages)
  147.    NOPVT   NOPRIVATE    NO_PRIVATE    (do not allow private messages)
  148.    NOCOM   NOCOMMENTS   NO_COMMENTS   (do not allow comments)
  149.    NOADD   NOADDRESS    NO_ADDRESSED  (do not allow messages addressed)
  150.    NOALL   NOTOALL      NO_TOALL      (do not allow messages to 'ALL')
  151.    NOANS   NOANSI       NO_ANSI       (do not allow (break) ANSI sequences)
  152.    NOATC   NOATCODES    NO_ATCODES    (do not allow (break) PCBoard @..@ codes)
  153.    NOFIL   NOFILE       NO_FILES      (do not allow file attaches)
  154.    NONOE   MUSTECHO     MUST_ECHO     (always honor the ECHO flag)
  155.    NOROU   NOROUTED     NO_ROUTED     (do not allow routed messages)
  156.  
  157. Usage:
  158.  
  159.   The DEFAULTFLAGS= keyword tells RNET the flags to apply to all CONF=
  160.   statements that follow it.  If not specified, the defaults for conferences
  161.   are:  PUBLIC TOALL ADDRESSED.  Example:
  162.  
  163.   DEFAULTFLAGS=PUBLIC PRIVATE TOALL ADDRESSED ANSI
  164.  
  165.   The CONF= statement has been expanded to allow the addition of a conference
  166.   specific filter file and the above flags.  This method is easier to maintain
  167.   and config than the old "list of conference numbers" method.  Example CONF=
  168.   statements:
  169.  
  170.   DEFAULTFLAGS=PUBLIC PRIVATE TOALL ADDRESSED ANSI
  171.   CONF=1,254            ;(local 1 == host 254; default flags used; tag0)
  172.   CONF=2,255:1          ;(conf 2 == host 255; default flags; tag1)
  173.   CONF=3,256:1 none     ;(htag1/tag1 used; default; no filters (global only))
  174.   CONF=4,257:1 atl.fil  ;(use ATL.FIL for filter/tcan/tracking)
  175.   CONF=5,258:1 none      NOPVT     ;(uses default; PRIVATE is turned off)
  176.   CONF=6,259:5 ilink.fil ROUTED    ;(use ilink.fil filters; routed mail; tag5)
  177.   CONF=7,260:0 none      NOALL NOANSI  ;(TOALL and ANSI overridden)
  178.  
  179.   In general, setup DEFAULTFLAGS= to have the global rules for the network you
  180.   are echoing.  Then, use CONF=local,host.  If you want a different tagline
  181.   than HTAG0/LTAG0, add a ":tag#".  If you want a conference specific filter
  182.   file applied, add that after the tagline entry.  Use "none" if no conference
  183.   specific filters are to be applied.  Beyond the filter filename, list any
  184.   changes to the DEFAULTFLAGS= entries (turning on or off whatever flags are
  185.   approperate).  For the majority of the conferences, a simple CONF=#,# will
  186.   be all that's needed.
  187.  
  188.   Any ';' or '(' denotes the beginning of a comment -- the rest of the line is
  189.   ignored.
  190.  
  191. _______________________________________________________________________________
  192.  
  193.                         Programmable 'Filter' Language
  194.  
  195.   The programmable filter language uses keywords to allow specification of
  196.   what RNET should do with certain messages.  You do *NOT* need to understand
  197.   or use the programmable filter language to use RNET.  The old style TCAN=
  198.   HANDLE=, TCANTAG=, type statements still work.  The filter language gives
  199.   you some additional abilities and features.
  200.  
  201.   In general, the language syntax is as follows:
  202.  
  203.       [process] [where] [what] "text string" [function] "spec string"
  204.  
  205.    Process  = Import, Export, Either, Both
  206.    Where    = Name, User, Who, TO, FROM, Tagline, Body, Subject
  207.    What     = Has, Includes, Contains, =, Is, Equals
  208.    "text"   = Text string to search for
  209.    Function = Replacewith, =, Subst, Strip, Public, Private, Comment,
  210.               Tcan, Allow, Log, Write, Track
  211.    "spec"   = "replacement text" for replacewith, subst, =
  212.               "filename" for log, write, track
  213.  
  214.   The interpeter is smart enough to figure out most any way you want to
  215.   express your filters.  Simply use a text editor to create a filter file
  216.   using names such as NETWORK.FIL, CONF50.FIL, or GLOBAL.FIL.
  217.  
  218.   Blank lines and lines starting with a ';' are ignored.  You cannot place
  219.   comments in the middle or at the end of a line since the ';' might be part
  220.   of a text string.
  221.  
  222.   In the filter file, state, one per line, the filter instructions desired.
  223.   Examples of valid filter instruction lines (all of these do the exact same
  224.   thing):
  225.  
  226.     IF DURING IMPORT NAME EQUALS "ROBERT VOSTREYS" THEN REPLACEWITH "SYSOP"
  227.     IF IMPORT NAME IS "ROBERT VOSTREYS" REPLACEWITH "SYSOP"
  228.     IMPORT NAME = "ROBERT VOSTREYS" = "SYSOP"
  229.     IF NAME = "ROBERT VOSTREYS" DURING IMPORT SUBST "SYSOP"
  230.  
  231.   The last one, while out of order as per the language rules, still works! If
  232.   the interpreter cannot discern what you want it to do, it will log the
  233.   missing "parts" to WARNING.LOG.  The language is NOT case sensitive -- CAPS
  234.   were used here to avoid confusion.
  235.  
  236. Keywords -- Process:
  237.  
  238.   IMPORT  = only apply filter during IMPORT
  239.   EXPORT  = only apply filter during EXPORT
  240.   EITHER  = apply filter during IMPORT and EXPORT
  241.   BOTH    = apply filter during IMPORT and EXPORT
  242.   ANYTIME = apply filter during IMPORT and EXPORT
  243.  
  244. Keywords -- Where:
  245.  
  246.   NAME    = TO or FROM name
  247.   USER    = TO or FROM name
  248.   WHO     = TO or FROM name
  249.   TO      = TO name
  250.   FROM    = FROM name
  251.   TAG     = tagline
  252.   TAGLINE = tagline
  253.   BODY    = message body and tagline
  254.   TEXT    = message body and tagline
  255.   SUBJECT = subject
  256.  
  257. Keywords -- What (must be followed by a "text string"):
  258.  
  259.   HAS     = check that the "text string" is contained anywhere within
  260.   INCLUDES= same as HAS
  261.   CONTAINS= same as HAS
  262.   EQUALS  = TO, FROM, SUBJECT must start with specified "text string"
  263.   IS      = same as EQUALS
  264.   =       = same as EQUALS
  265.  
  266. Keywords -- Do (some functions require a following "spec string"):
  267.  
  268.   REPLACEWITH = replace found text with following text (replaces entire TO,
  269.                 FROM, SUBJECT; replaces only found text in body or tagline)
  270.   SUBST       = same as REPLACEWITH
  271.   =           = same as REPLACEWITH
  272.   STRIP       = remove line from body or strip tagline (doesn't do anything
  273.                 for TO, FROM, SUBJECT fields)
  274.   CUT         = same as strip
  275.   PUBLIC      = force message PUBLIC
  276.   MAKEPUBLIC  = same as PUBLIC
  277.   PRIVATE     = force message PRIVATE
  278.   MAKEPRIVATE = same as PRIVATE
  279.   COMMENT     = force message to be a COMMENT (only sysop level can read)
  280.   TCAN        = do not allow message ("spec" holds filename to write msg to)
  281.   DUMP        = same as TCAN
  282.   KEEP        = allow message to override conference rules (public, private,
  283.                 routed, etc.. usually used to allow a Moderator to send
  284.                 private messages in a public echo)
  285.   ALLOW       = same as KEEP
  286.   LOG         = write message to a log file (specified in "spec" that follows)
  287.   WRITE       = same as LOG
  288.   MSG         = same as LOG
  289.   HEADER      = write message header (date, to, from, subject) to "spec" log
  290.   TRACK       = same as HEADER
  291.  
  292. Keywords -- Ignored:   IF DURING THE MESSAGE WHEN OR AND
  293.  
  294.   Other example filter statements:
  295.  
  296.     if import name = "FRANK BARRETT" tcan "frank.log"
  297.     if import to = "ALL  " makepublic
  298.     if export tag has "TXT2MSG" strip
  299.     if import tag has "■ ByteBro" write "bb_tag.log"
  300.     if import tag has "■ ByteBro" tcan
  301.     if import body has " Ilink" subst " ILink"
  302.     if import body has " TRP " subst " TRP<tm> "
  303.     allow if import or export name is "BOBBY SUMRADA"
  304.     if subject is "New Member" allow
  305.     if subject has "is now carrying this conf" tcan
  306. _______________________________________________________________________________
  307.  
  308.                                RNET @..@ Codes
  309.  
  310.   RNET allows you to use specialized @..@ codes when specifying filenames and
  311.   in customized reports (not yet documented). These @..@ codes are most useful
  312.   for your DAILY type logs where you want a log kept for each day of the week,
  313.   or month, or whatever.  RNET will always delete "tomorrows" log if using a
  314.   date based filename -- thus, if using @WEEKDAY@.LOG and today is Sunday,
  315.   RNET will write to SUN.LOG and will delete MON.LOG if it exists.
  316.  
  317.   Note: You can also use *any* environment variables when specifying filenames
  318.   in your CFGs.
  319.  
  320.   For example:      %PCBDRIVE%%PCBDIR%\@WEEKDAY@_@HOSTID@.@MONTHSHORT@
  321.   Might yield:      C:\PCB\SUN_FTL.JAN   (not very useful)
  322.     (note the '\' after %PCBDIR% since PCBDIR= environment doesn't have one)
  323.  
  324.   Another example:  @HOME@@WEEKDAY@_@HOUR12@@AMPM@.LOG
  325.   Might result in:  K:\RNET\SUN_04AM.LOG  (more useful)
  326.     (note no '\' after @HOME@, since RNET knows to put one there)
  327.  
  328.                               General @..@ Codes
  329.                               ------------------
  330.   @HOME@          = "home" directory of RNET (blank or specified by RNET= env)
  331.   @NODE@          = node number for this node (either by PCBNODE= or PCB.DAT)
  332.   @HOST@          = specified <hostid> name
  333.   @HOSTID@        = specified <hostid> name
  334.   @LOCAL@         = specified <localid> name
  335.   @LOCALID@       = specified <localid> name
  336.  
  337.                              Time/Date @..@ Codes
  338.                              --------------------
  339.   @WN@            = Weekday number (0=sun, 6=sat)
  340.   @WEEKDAYNUM@    = Weekday number (0=sun, 6=sat)
  341.   @WS@            = Weekday short name (SUN, MON,...SAT)
  342.   @WD@            = Weekday short name (SUN, MON,...SAT)
  343.   @WEEKDAY@       = Weekday short name (SUN, MON,...SAT)
  344.   @DAYOFWEEK@     = Weekday short name (SUN, MON,...SAT)
  345.   @WL@            = Weekday long name (Sunday...Saturday)
  346.   @WEEKDAYLONG@   = Weekday long name (Sunday...Saturday)
  347.   @DN@            = Day of the month (2 digit, 00..31)
  348.   @DAY@           = Day of the month (2 digit, 00..31)
  349.   @DAYOFMONTH@    = Day of the month (2 digit, 00..31)
  350.   @DY@            = Day of the year (3 digit, 001..366)
  351.   @DAYOFYEAR@     = Day of the year (3 digit, 001..366)
  352.   @MN@            = Month number (2 digit, 01..12)
  353.   @MONTH@         = Month number (2 digit, 01..12)
  354.   @MONTHNUM@      = Month number (2 digit, 01..12)
  355.   @MS@            = Month short name (JAN,FEB,...DEC)
  356.   @MONTHSHORT@    = Month short name (JAN,FEB,...DEC)
  357.   @ML@            = Month long name (January..December)
  358.   @MONTHLONG@     = Month long name (January..December)
  359.   @YS@            = Year short number (2 digit, 01..99)
  360.   @YEARSHORT@     = Year short number (2 digit, 01..99)
  361.   @YL@            = Year long number (4 digit, 1990..2099)
  362.   @YEARLONG@      = Year long number (4 digit, 1990..2099)
  363.   @WK@            = Week of the year (2 digit, 01..57)
  364.   @WEEK@          = Week of the year (2 digit, 01..57)
  365.   @WEEKNUM@       = Week of the year (2 digit, 01..57)
  366.   @H12@           = Hour, 12 hour format (2 digit, 01..12)
  367.   @12HOUR@        = Hour, 12 hour format (2 digit, 01..12)
  368.   @H24@           = Hour, 24 hour format (2 digit, 00..23)
  369.   @24HOUR@        = Hour, 24 hour format (2 digit, 00..23)
  370.   @HOUR@          = Hour, 24 hour format (2 digit, 00..23)
  371.   @MIN@           = Minutes (2 digit, 00..59)
  372.   @M@             = Minutes (2 digit, 00..59)
  373.   @AP@            = AM or PM (2 char)
  374.   @AM@            = AM or PM (2 char)
  375.   @AMPM@          = AM or PM (2 char)
  376.  
  377.                @..@ Codes Useful for RNETPACK.BAT/RNETPACK.LST
  378.                -----------------------------------------------
  379.   @CONF@          = Conference number (0..65534)
  380.   @CONFNUM@       = Conference number (0..65534)
  381.   @CONFNAME@      = Conference name (Main Board, sci.astro, etc)
  382.   @MSGFILE@       = Conference messagebase (d:\pcb\conf\main, k:\conf55\msgs)
  383.  
  384.   If you can think of any other @..@ codes you'd like to use, let me know.
  385.  
  386. _______________________________________________________________________________
  387.  
  388.